home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 25
/
Cream of the Crop 25.iso
/
bbs
/
muep014.zip
/
MUE.DOC
< prev
next >
Wrap
Text File
|
1997-03-27
|
13KB
|
279 lines
┌──────────────────────────────────────────────────────────────────────────────┐
│ MUE Maximus User Editor v0.14wb ∙ Documentation ∙ Wide Beta Version │
└──────────────────────────────────────────────────────────────────────────────┘
As much as I have tried to make this program usable without docs, it
has become necessary due to the complexity of the beast. As they say,
documentation is the worst part for a programmer and I guess I'm no
exception to this saying... Hopefully I have covered the basics with-
out boring you too much in this file.
Keys and their uses:
For the most part this section is a long winded version the MUE.HLP
file included in the archive. However some keys may not be listed in
the help file and perhaps some more detail on the keys and uses may
be of help here.
= (equal) - Toggles the displaying of user passwords. Note that
sysop level user passwords are not displayed. This
is a minor security attempt for prying eyes. In all
cases (except when encrypted passwords are used) the
password is displayed when editing a password.
^P or | - (Control-P) Packs/Purges the user base.
^R - (Control-R) Restore purged users.
^S - (Control-S) Sort the user base.
ALT-(Key) - This toggles the current users (key). Example ALT-K
toggles the K key.
ESC - Toggles the main menu.
F1 - Displays the MUE.HLP (help) text file.
PageDn - Jump/decrement 10 users down from the current user.
PageUp - Jump/increment 10 users up from the current user.
Dn or Rt - Display the next user record.
Up or LF - Display the previous user record.
1 or Home - Jumps to the first user record.
A - Change the current users access level.
C - Change the current users compression method.
D or DEL - Toggles the Delete flag for the current user.
E - Edit non hotkey fields.
F - Change the current users flags.
G# - Go to user #.
H - Change the current users Help Level.
J or END - Jumps to the last user record.
K - Change the current users keys. Using this option will
display the key values as set in the Configuration >
Key Labels menu option. Keys can also be toggled by
pressing ALT-(key). See ALT-(Key) above.
L - Change the current users Language.
N - Change the current users Nulls.
P - Toggle the current users PERM flag.
R - Change the current users Message/File Area.
S - Search menu.
T - Change the current users Transfer protocol.
V - Change the current users Video Mode.
W - Change the current users Password.
X - Change the current users EXpiration settings.
Command Line Switches:
First off, you can run MUE and pass the /H switch for the command
line switch help. This yields basic help/instructions for the
different switches.
/B This runs MUE in Monochrome mode. Essentially Black & White.
/C Configuration file switch. This allows you to specify a path
and file name to your .CFG file. Useful for having multiple
configuration files or keeping the .CFG file in a directory
other than the \MAX directory. Usage: MUE /Cc:\max\mue.cfg.
/G### Go to user ###.
/M Maximus .PRM switch, default is the MAXIMUS environment
variable. Use this to override or replace the MAXIMUS
environment variable. Usage: MUE /Mc:\max\max.prm.
/P Purge the USER base. This will purge users based on settings
in the Global > Purge Settings menu as well as users marked
deleted. Useful in nightly maintenance batches.
/Sm[s] Sort the user base. This switch will sort the user base and
save it that way. Useful in nightly maintenance batches.
The m field is the Major sort option and s is the optional
secondary sort option. Keys for these are simply the hotkey
characters used within the Sort menu as shown below:
1 = 1st Name M = Message Area
L = Last Name B = DOB
A = AccessLvl I = AlIas
C = City S = LaSt Call
P = Phone # # = # Calls
T = DaTa # D = DnLoad Kb
F = File Area U = UpLoad Kb
For example: MUE /Sal
Will sort the user base by Access level and then by last name
as a secondary sort within the access levels. Note that you
may have mixed results with the secondary sort option. Some
major sorts don't lend well to secondary sorts. This was
implemented mostly for sorting by names within the Access
level sort.
/U User base switch. Use this to override the MAX.PRM setting.
Useful for testing purposes more than anything else.
Files used/created by MUE:
First of all MUE requires a Maximus version 3.0x USER.BBS file,
second it requires your MAX.PRM file. Due to the flexibility of
Maximus 3.0x, the MAX.PRM file is an absolute necessity for MUE.
For this reason, you must have an environment variable set for
Maximus or you need to pass the path and file name to your MAX.PRM
file. See the command line switch, /M, on how to pass it to MUE.
Other files used/created are MUE.CFG, MUE.HLP, USER.BAK, USER.EXT,
USER.EXB, and USER.PRG.
MUE.CFG is where your configuration settings are stored.
MUE.HLP is a flat ASCII text file that is displayed when F1 is
pressed. This file can be custom configured to suit your personal
needs, the only limitation are the file cannot exceed 21 lines or
have lines longer than 80 characters. Any text outside of these
limits are simply truncated.
USER.BAK is created when packing or purging the user base. It's
simply a backup of your USER.BBS file prior to packing/purging.
USER.EXT is where MUE stores any user descriptions. This file is
compatible with UEDIT, so if you used it with UED then you'll still
have your descriptions.
USER.EXB is simply a backup of the USER.EXT file prior to packing/
purging users.
Configuration - Color Options:
This option may be misleading, you cannot actually set colors per se,
rather you can only choose predefined color settings. Mono is the
choice for monochrome monitors. Color1 or Color2 are of course for
systems with a color monitor.
Configuration - Date Format:
Here's where you choose your date format for any displayed date field.
Choices are MM/DD/YY, DD/MM/YY, or YY/MM/DD.
Configuration - Key Labels:
Here's where you can define the purpose of the keys as used on your
system. The definitions are displayed when you choose the 'K' Keys
hotkey while viewing a user record. They're displayed in the Expire
field (above the Keys field).
Configuration - Show Password:
This option toggles whether or not passwords are displayed while
viewing user records. This can be toggled via the '=' key as well.
Note that Sysop level users passwords are not displayed. This is a
minor attempt at security for any prying eyes. If you really need
to view a Sysop level users password then you need to edit it using
the W hotkey. You can of course just press ESC to abort any changes
to leave it alone.
Configuration - SOund:
This option toggles sound, some pop-up boxes beep if on.
Configuration - SaVe Settings:
Save your settings to the MUE.CFG file. All settings in the
Configuration as well as the Global > Key and Global > Purge
Settings menus are saved via this option.
File - Append Record:
This menu choice allows you to add a new user record. It defaults to
a user name of "New Record Created by MUE". Default settings via
Maximus are also set, such as Message area, File area, and Access
level. It's up to you to fill in the blanks beyond this.
File - Pack User File:
Pack/Purge the user base file. Settings in the Global > Purge
Settings are also processed with this choice.
File - Restore a User:
Have you ever deleted a user and wished there a way to put them
back? If so, then look no further! :-) You now have the ability to
do it assuming you used MUE to delete/purge it.
Choosing this option loads the USER.PRG file and allows you to TAG
user(s) to restore. After tagging (pressing the space bar), press
escape and you'll be prompted to restore them. Keep in mind that any
descriptions you may have had for the user(s) were lost in the pack/
purge process and cannot be restored.
Global - Key Settings:
This menu choice allows you to do a mass/global change on users keys.
First you need to choose which access levels to act on, second is the
keys you want to turn on or off.
It should be straight forward for the access levels, either they're ON
or OFF. ON means they're processed, OFF are not.
Key settings are -, ON, or OFF. Key(s) set to '-' are ignored, keys
set to ON are turned on for all access levels set to ON, and keys set
to OFF are turned off for access levels set to ON.
Once you make your choices, pressing control-P prompts you to process
them.
Global - Purge Settings:
This menu is where you set the purge settings. Access levels set to
NO are not processed.
If an Access level is set to YES then MUE looks at the number of days.
Users that have called less than number of DAYS are purged unless
they have exceeded the number of CALLS.
Note that values of 0 for DAYS or CALLS are ignored. Here's some
examples:
ACS = NO This level is ignored completely,
regardless of DAYS or CALLS.
ACS = YES DAYS = 0 CALLS = 0 This level is ignored completely,
because DAYS are set to 0 and
CALLS are also set to 0.
ACS = YES DAYS = 10 CALLS = 0 Callers in this level are purged
if they haven't called for 10
days or longer regardless of how
many times they have called.
ACS = YES DAYS = 30 CALLS = 10 Callers in this level are purged
if they haven't called for 30
days or more and have only called
10 or less times.
Global - Save As Sorted:
This option is only available if the user base has been sorted. This
will save the user base as sorted.
Global - Sort User File:
Here's where you can sort the user base. This does a sort of the base
in memory, if you want to save the base as sorted then you need to use
the Global > Save As Sorted menu option. Otherwise the sort isn't
saved.
There is an option to sort on a secondary field. Highlight the field
you want to sort as a secondary basis and press the space bar. This
will mark the field with >< characters to indicate your choice.
Highlighting a field and pressing enter will sort the user base based
on the field highlighted. Secondary sorts are based on the fields
surrounded by the >< characters.
Credits:
Before I forget, I have to give credit to Gary Zarzycki for a lot of
the nuts and bolts in this program. There are too many to list here,
but suffice it to say that were it not for him this program wouldn't
be where it is now (if ever), thanks Gary!
For the second color option, I thank Gary Gilmore. I liked it so much
I bought the company! :-) Okay I just implemented the colors, but I
do like them more than my original choice. See the COLOR2 option in
the Config Menu > Color Options for his suggestion.
And of course I can't forget Scott Dudley for creating and maintaining
Maximus, thanks Scott!